home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / gui / BGUI11B.lha / docs / mxclass.doc < prev    next >
Text File  |  1994-12-05  |  3KB  |  104 lines
  1.  
  2.            $RCSfile: mxclass.doc,v $
  3.         Description: Mxclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.1 $
  10.               $Date: 1994/07/04 21:05:30 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. mxclass/--background--
  16. mxclass/Methods
  17. mxclass/Attributes
  18.  
  19. mxclass/--background--                                  mxclass/--background--
  20.  
  21.     NAME
  22.         Class:          mxclass
  23.         Superclass:     groupclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  gadget  object simular to the gadtools.library it's mx
  28.         kind.  Objects  from this class send out the following attribute pairs
  29.         in their notification events:
  30.  
  31.         GA_ID           - Gadget object ID.
  32.         MX_Active       - Currently selected label.
  33.  
  34. mxclass/Methods                                                mxclass/Methods
  35.  
  36.     NEW METHODS
  37.         None.
  38.  
  39.     CHANGED METHODS
  40.         None.
  41.  
  42. mxclass/Attributes                                          mxclass/Attributes
  43.  
  44.     NAME
  45.         MX_Labels -- ( STRPTR * )
  46.  
  47.     FUNCTION
  48.         Set  the  labels  used  by  the  radio-buttons.  This  must point to a
  49.         NULL-terminated  array  of  string  pointers.  The strings will be the
  50.         labels of the buttons created by the class.   This  attribute  must be
  51.         valid.
  52.  
  53.         Default is NULL. Applicability is (I).
  54.  
  55.     NAME
  56.         MX_Active -- ( ULONG )
  57.  
  58.     FUNCTION
  59.         Set or get the currently active (selected) button.
  60.  
  61.         Default is 0. Applicability is (ISGNU).
  62.  
  63.     NAME
  64.         MX_LabelPlace -- ( ULONG )
  65.  
  66.     FUNCTION
  67.         Set  the place at which the labels of the button are placed. There are
  68.         two possibilities:
  69.  
  70.         PLACE_LEFT -- The labels are placed left of the buttons.
  71.         PLACE_RIGHT -- The labels are placed right of the buttons.
  72.  
  73.         Default is PLACE_RIGHT. Applicability is (I).
  74.  
  75.     NAME
  76.         MX_DisabledButton, MX_EnableButton -- ( ULONG )
  77.  
  78.     FUNCTION
  79.         Disable  or enable a single button in the mx object. The data of these
  80.         tags must be the number of the button you wish to enable or disable.
  81.  
  82.         No default. Applicability is (ISU).
  83.  
  84.     NAME
  85.         MX_TabsObject -- ( BOOL )
  86.  
  87.     FUNCTION
  88.         To make the object a tabs object. A tabs object is an object  which is
  89.         rendered simular  to  tabs in a book.   When this attribute is set you
  90.         will  get  an object which is perfect to select pages from a pageclass
  91.         object.
  92.  
  93.         Default is FALSE. Applicability is (I).
  94.  
  95.     NAME
  96.         MX_TabsTextAttr -- ( struct TextAttr * )
  97.  
  98.     FUNCTION
  99.         To determine the font  in  which  the labels of the tabs are rendered.
  100.         NULL means that the font is the same as  the  font  used  by the other
  101.         objects in the window.
  102.  
  103.         Default is NULL. Applicability is (I).
  104.